Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: final review of light client developer guide #3081

Merged
merged 29 commits into from
Feb 9, 2023
Merged

docs: final review of light client developer guide #3081

merged 29 commits into from
Feb 9, 2023

Conversation

tmsdkeys
Copy link
Contributor

Description

Final review of the light client developer docs. Made some corrections/changes:

  • fixed order of modules/core/exported in a few instances
  • moved setup.md to the end as it makes more sense imo
  • combined the section on ClientMessage with the one one handling updates and misbehaviour as they respond to the ClientMessage, it looked cleaner
  • moved upgrade.md before proofs.md
  • Made upgrade.md easier to read by moving some text around and adding sections
  • added some content in proofs.md as there was a circular referencing with client-state.md
  • added a code block to proposal.md
  • fixed the vuepress config as there was an incorrect ordering
  • other stylistic changes performed by @crodriguezvega

Commit Message / Changelog Entry

docs: final review of light client developer guide

see the guidelines for commit messages. (view raw markdown for examples)

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

AdityaSripal
AdityaSripal approved these changes Jan 30, 2023
View reviewed changes
Copy link
Member

@AdityaSripal AdityaSripal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice cleanup!

@tmsdkeys
Copy link
Contributor Author

tmsdkeys commented Jan 30, 2023 •
edited
Loading

Potential additional changes to consider:

  • Now that we discuss upgrade handling for light client devs in the light client dev guide, we should likely remove it from the 'upgrades' section of the docs? Maybe just add a link...
  • in client-state.md some methods in the interface are not listed. don't know if this is on purpose? UpdateStateOnMisbehaviour, UpdateState, CheckSubstituteAndUpdateState and VerifyUpgradeAndUpdateState are missing

damiannolan
damiannolan approved these changes Feb 1, 2023
View reviewed changes
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tmsdkeys! LGTM

@crodriguezvega
Copy link
Contributor

Potential additional changes to consider:

  • Now that we discuss upgrade handling for light client devs in the light client dev guide, we should likely remove it from the 'upgrades' section of the docs? Maybe just add a link...

I removed the text that was there and added a link to the section.

  • in client-state.md some methods in the interface are not listed. don't know if this is on purpose? UpdateStateOnMisbehaviour, UpdateState, CheckSubstituteAndUpdateState and VerifyUpgradeAndUpdateState are missing

I added a comment in client-state.md to clarify that not all methods of the interface are listed there and some methods are explained in detail in other sections.

crodriguezvega
crodriguezvega approved these changes Feb 9, 2023
View reviewed changes
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @tmsdkeys!

@crodriguezvega crodriguezvega merged commit fdadae5 into main Feb 9, 2023
@crodriguezvega crodriguezvega deleted the thomas/light-client-dev-guide-review branch February 9, 2023 09:41
@mergify mergify bot mentioned this pull request Feb 9, 2023
Merged
mergify bot pushed a commit that referenced this pull request Feb 9, 2023
@tmsdkeys @mergify
docs: final review of light client developer guide (#3081)
d41218c 
Co-authored-by: crodriguezvega <[email protected]>
(cherry picked from commit fdadae5)
crodriguezvega added a commit that referenced this pull request Feb 9, 2023
@mergify @tmsdkeys @crodriguezvega
docs: final review of light client developer guide (backport #3081) (#…
cb1a3cd 
…3130)

* docs: final review of light client developer guide (#3081)

Co-authored-by: crodriguezvega <[email protected]>
(cherry picked from commit fdadae5)

* fixed alignment

* fixed alignment

---------

Co-authored-by: tmsdkeys <[email protected]>
Co-authored-by: Carlos Rodriguez <[email protected]>
stackman27 pushed a commit to stackman27/ibc-go that referenced this pull request Mar 13, 2023
@tmsdkeys @crodriguezvega @stackman27
docs: final review of light client developer guide (cosmos#3081)
3a20c2c 
Co-authored-by: crodriguezvega <[email protected]>
@faddat faddat mentioned this pull request Jun 23, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@damiannolan damiannolan damiannolan approved these changes

@crodriguezvega crodriguezvega crodriguezvega approved these changes

@AdityaSripal AdityaSripal AdityaSripal approved these changes

@colin-axner colin-axner Awaiting requested review from colin-axner

@charleenfei charleenfei Awaiting requested review from charleenfei

@chatton chatton Awaiting requested review from chatton chatton is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@tmsdkeys @crodriguezvega @damiannolan @AdityaSripal